Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CentralizedTelescope: Adding doc #126

Merged
merged 3 commits into from
Jan 21, 2025
Merged

CentralizedTelescope: Adding doc #126

merged 3 commits into from
Jan 21, 2025

Conversation

rrtoledo
Copy link
Collaborator

@rrtoledo rrtoledo commented Jan 14, 2025 •
edited
Loading

Content

This PR includes:

  • Adding doc to public facing functions

Pre-submit checklist

  • Branch
    • Tests are provided (if possible)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
  • PR
    • No clippy warnings in the CI
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested
  • Documentation
    • Update README file (if relevant)
    • Update documentation website (if relevant)

Comments

Misc changes from former #66 and #116

To easily import the doc changes, I had to import some changes on the code. These can be dismissed in this PR as they are already in previous ones.

Issue(s)

Relates to #59

@rrtoledo rrtoledo self-assigned this Jan 14, 2025
curiecrypt
curiecrypt reviewed Jan 15, 2025
View reviewed changes
Copy link
Collaborator

@curiecrypt curiecrypt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not reviewed the PR yet. However, the CI failed; I assume it was caused because of changes in the code structure.

@curiecrypt
Copy link
Collaborator

I have not reviewed the PR yet. However, the CI failed; I assume it was caused because of changes in the code structure.

Sorry! You already said it is failing.

@rrtoledo
Copy link
Collaborator Author

rrtoledo commented Jan 16, 2025 •
edited
Loading

I have not reviewed the PR yet. However, the CI failed; I assume it was caused because of changes in the code structure.

Sorry! You already said it is failing.

@curiecrypt Can you just look at the change in comments? This PR will be merged after the others, so we won't have any failing CI.

curiecrypt
curiecrypt previously approved these changes Jan 20, 2025
View reviewed changes
Copy link
Collaborator

@curiecrypt curiecrypt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added very minor suggestions. They could be handled in cargo doc PRs as well. So, feel free to ignore them.
LGTM 👍

src/centralized_telescope/cases.rs Outdated Show resolved Hide resolved
src/centralized_telescope/proof.rs Outdated Show resolved Hide resolved
src/centralized_telescope/proof.rs Outdated Show resolved Hide resolved
src/centralized_telescope/proof.rs Show resolved Hide resolved
src/centralized_telescope/proof.rs Outdated Show resolved Hide resolved
@rrtoledo
Copy link
Collaborator Author

Accepting suggestions, and rebasing before merging

@rrtoledo rrtoledo merged commit ee558ef into main Jan 21, 2025
1 check passed
@rrtoledo rrtoledo deleted the raph@restruct-doc branch January 21, 2025 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@curiecrypt curiecrypt curiecrypt left review comments

@tolikzinovyev tolikzinovyev Awaiting requested review from tolikzinovyev

Assignees

@rrtoledo rrtoledo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rrtoledo @curiecrypt